package com.etc.config;

import java.util.ArrayList;
import java.util.List;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * 
 * @ClassName: Swagger2
 * @Description: TODO(这里用一句话描述这个类的作用)
 * @author knowno
 * @date 2022年4月7日 上午10:05:27
 *
 */
@Configuration
@EnableSwagger2
public class Swagger2 {

	// swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等
	// 创建一个bean
	@Bean
	public Docket createRestApi() {
		// 添加head参数start
		ParameterBuilder tokenPar = new ParameterBuilder();
		List<Parameter> pars = new ArrayList<Parameter>();
		tokenPar.name("token").description("令牌").modelRef(new ModelRef("string")).parameterType("header")
				.required(false).build();
		pars.add(tokenPar.build());
		// 添加head参数end
		return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
				// 为当前包路径 com.etc.controller 控制器所在的包
				.apis(RequestHandlerSelectors.basePackage("com.etc.controller")).paths(PathSelectors.any()).build()
				.globalOperationParameters(pars).apiInfo(apiInfo());
		
	}

	// 构建 api文档的详细信息函数,注意这里的注解引用的是哪个
	private ApiInfo apiInfo() {
		return new ApiInfoBuilder()
				// 页面标题
				.title("测试使用 Swagger2 构建RESTful API")
				// 创建人
				.contact(new Contact("小白", "http://zretc.net", ""))
				// 版本号
				.version("1.0")
				// 描述
				.description("API 描述").build();
	}

}
